home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 19 / Night Owl (The Best of Shareware)(NOPV 19)(1996).ISO / 007a / statsp4c.zip / STATUSP.DOC < prev    next >
Text File  |  1996-01-01  |  22KB  |  490 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                         Network Mail Status - Postlink Version
  8.  
  9.           ═════════════════════════════════════════════════════════════════
  10.  
  11.                First off I would like to thank those users who have offered
  12.           suggestions  and made  comments  on StatusP.  Some functions  and
  13.           displays,  even CleanUpP (formally  CleanUp), and  other versions
  14.           are the direct result of this input.
  15.  
  16.                (1) Generates a network  Export mail status bulletin showing
  17.           each conference  (full 24 characters for  conference names), 1500
  18.           maximum, and  the total number  of messages exported  for current
  19.           date and total  to date for  each conferences, total  conferences
  20.           and the total messages to date for the specified network.
  21.  
  22.                (2) Generates a network Import mail status bulletin with the
  23.           same  format as  the Export  bulletin. Since  the export  routine
  24.           contains  all conference names it is run first to get those names
  25.           so  that conferences with zero imports are still displayed in the
  26.           import  bulletin. I  could  not  find  another  way  to  get  all
  27.           conference names.
  28.  
  29.                (3)  Generates  last  import  bulletin  showing  last import
  30.           information: date,  time, total messages imported  in last import
  31.           and total messages imported to date.
  32.  
  33.                (4)  Generates, or appends to  the end of,  a monthly totals
  34.           bulletin called  network.TOT  with each  rollover. This  bulletin
  35.           contains  the  total  lines   from  previous  Export  and  Import
  36.           bulletins along with header.
  37.  
  38.                Supports  multiple networks.  This  program uses  Postlink's
  39.           export  / import  log(s). Single  or  separate Import  and Export
  40.           logs. It does  a monthly  rollover of the  LOG(s) using  PKWare's
  41.           PKZIP.EXE (copyright PKWare).
  42.  
  43.                This archive should contain the following files:
  44.  
  45.                CLEANUPP.DOC.......... Instructions for running CleanUpP
  46.                CLEANUPP.EXE.......... Postlink log reduction utility
  47.                DOORS.TXT............. Current list of James Huckabey doors
  48.                FILE_ID.DIZ........... BBS description file
  49.                SHAREWARE.TXT......... Information about shareware
  50.                HUCKABEY.TXT.......... Current list of all James Huckabey
  51.                                       software
  52.                READ.ME............... Update/changes information
  53.                STATUSP.BAT........... Sample batch file
  54.                STATUSP.EXE........... Actual StatusP program
  55.                STATUSP.DOC........... Instructions for running StatusP
  56.                STATUSP.CFG........... Sample configuration file     
  57.                STATUSP2.CFG.......... Sample configuration file
  58.                STATUSP3.CFG.......... Sample configuration file
  59.                ARCHIVE.TXT........... This list of files
  60.  
  61.  
  62.  
  63.  
  64.  
  65.                Syntax is pretty straight forward:
  66.  
  67.  
  68.                                  STATUSP STATUSP.CFG
  69.  
  70.  
  71.                Full path  to STATUSP.EXE may be  used if not in  path or in
  72.           current  directory.  If  you do  use  a  path  statement in  your
  73.           execution of Status (not in  current dir or in path) you  need to
  74.           set the  environment variable  "SET STATUSP=path  to STATUSP.EXE"
  75.           (SET STATUSP=C:\UTILITY\OTHER, etc. no ending slash is needed).
  76.  
  77.                It  is  not  necessary  to  add  a  path  statement  to  the
  78.           configuration file since the program finds itself. Of  course the
  79.           file must  be in  location of STATUSP.EXE.  If the  configuration
  80.           file  is not in the same location  then use the path statement to
  81.           it's location. 
  82.  
  83.                "STATUSP.CFG" and can have any file name with the  following
  84.           format. You can  use up to 8 characters of  your network name for
  85.           the  name  of your  .CFG file  if  that helps  keep multi-network
  86.           configurations clearer. This would  be the easiest way to  do it.
  87.           Each  line must  be  populated  with  a  valid  entry.  Paths  to
  88.           bulletins or logs are not needed if they are in or written to the
  89.           current directory:
  90.  
  91.                          (1) Unregistered BBS
  92.                          (2) 0000
  93.                          (3) Network
  94.                          (4) POST1.LOG
  95.                          (5) C:\BBS\BLT1
  96.                          (6) POST2.LOG
  97.                          (7) C:\BBS\BLT2
  98.                          (8) C:\BBS\BLT3
  99.                          (9) PCB
  100.                          (10) Bright
  101.  
  102.  
  103.                                      CFG line #1
  104.  
  105.                "Unregistered BBS", BBS name if registered.
  106.  
  107.  
  108.                                      CFG line #2
  109.  
  110.                "0000", valid serial number if registered.
  111.  
  112.  
  113.                                      CFG line #3
  114.  
  115.                "Network" should be the  name of the actual network  you are
  116.           using, one word  and case sensitive  (Rime, AccessNet, etc.).  18
  117.           characters max,  longer names are  truncated. Say you  are making
  118.           two different network mail runs with the same software, you would
  119.  
  120.  
  121.  
  122.  
  123.  
  124.           use those names here, each in it's own configuration file.
  125.  
  126.            
  127.                                      CFG line #4
  128.  
  129.                "POST1.LOG" is  the path  and name of  your Postlink  Export
  130.           log.  Lines #4  and #6  may contain  the same  file name  if your
  131.           Export and Import logs are in one file.
  132.  
  133.  
  134.                                      CFG line #5
  135.  
  136.                "C:\BBS\BLT1" is the path and name for your Export bulletin.
  137.  
  138.  
  139.                                      CFG line #6
  140.  
  141.                "POST2.LOG"  is the path  and name  of your  Postlink Import
  142.           log.  Lines #4  and #6  may contain  the same  file name  if your
  143.           Export and Import logs are in one file.
  144.  
  145.  
  146.                                      CFG line #7
  147.  
  148.                "C:\BBS\BLT2" is the path and name for your Import bulletin.
  149.  
  150.  
  151.                                      CFG line #8
  152.  
  153.                "C:\BBS\BLT3"  is the  path and  name for  your Last  Import
  154.           bulletin.  If you are not using this  option the file can just be
  155.           written out to the current directory, but it must be generated.
  156.  
  157.  
  158.                                      CFG line #9
  159.  
  160.                Color  and characters  used are  setup to  give you  as much
  161.           control over the output as  possible. Not all users can read  and
  162.           handle IBM extended graphic characters (like sight impaired users
  163.           and  voice  hardware).  Program can  use  either  "=/-" or  IBM's
  164.           extended graphic  characters "═/─". Line  #9 must contain  one of
  165.           the following options:
  166.  
  167.                "PCB" use IBM extended  graphic characters and PCBoard's @X0
  168.           colorizing codes.
  169.  
  170.                "PCB2" use no IBM  extended graphic characters and PCBoard's
  171.           @X0 colorizing codes.
  172.  
  173.                "ANSI"   use  colorizing   and  no   IBM  extended   graphic
  174.           characters.
  175.  
  176.                "ANSI2" use colorizing and IBM extended graphic characters.
  177.  
  178.  
  179.  
  180.  
  181.  
  182.                "ASCII"  use  no  colorizing  and no  IBM  extended  graphic
  183.           characters.
  184.  
  185.                "ASCII2"  use no  colorizing, but  use IBM  extended graphic
  186.           characters.
  187.  
  188.  
  189.                                      CFG line #10
  190.  
  191.                Text Tone: This option  can either be Bright or  Normal. The
  192.           default is BRIGHT. Even if you are using an ASCII option you must
  193.           still populate this option.
  194.  
  195.  
  196.                                 STATUSP TOTAL FILE(s)
  197.  
  198.                This  file,  StatusP  Totals,  is  written  to  the  current
  199.           directory only. Current directory is the directory where you call
  200.           STATUSP.EXE from.  The file name is the  first eight alphabetical
  201.           characters  of  your network  name. That  way  if you  are making
  202.           multiple network mail runs each network will have it's own totals
  203.           file. The extension is always "TOT".
  204.  
  205.                Please  make  note  that if  your  copy  of  StatusP is  not
  206.           registered that the  total file will  have "Unregistered BBS"  in
  207.           the BBS line  of the bulletin. If you keep  the file and register
  208.           StatusP  you will have  to edit the  top line of  the bulletin or
  209.           erase the file and start over.
  210.  
  211.                This file/bulletin  has unlimited possibilities.  If you are
  212.           making  more  than  one  StatusP  execution,  say  for  different
  213.           formats, only the first  one will be executed with  the rollover.
  214.           So this file will only contain that color format.  It is complete
  215.           with  whatever color codes existed  in the original bulletin. The
  216.           colors can be removed  or replaced with whatever colors  you want
  217.           manually using a text editor.
  218.  
  219.                The file has  a three  line header when  first created,  (1)
  220.           line with BBS name in it, (2) an explanation of what it is, (3) a
  221.           header  termination line. It then  has one line  for Export total
  222.           and  one line  for Import  total followed  by a  blank separation
  223.           line.  Each successive appendage  is three lines  total. A year's
  224.           worth of information would have a total of thirty-nine lines.
  225.  
  226.                What you do with this information is up to you. Just another
  227.           friendly option added to the program. If you are going  to use it
  228.           as an active bulletin  it can be copied  anywhere you want.  Just
  229.           make sure  that if you want the next rollover appended to the end
  230.           that you keep the file in the current directory for the execution
  231.           of StatusP.  If you change this directory  make sure you move the
  232.           total bulletin(s) to your new directory.
  233.  
  234.  
  235.  
  236.  
  237.  
  238.                    Special Bulletins Showing Totals Each Conference
  239.  
  240.                It  is  possible  to  make  a  "Previous  Month's"  activity
  241.           bulletin out of  the rolled over log(s). At least  the data would
  242.           be  all there and  compacted if you  have used  CleanUpP. All you
  243.           have to  do is make a  special STATUSP.CFG file with  the name of
  244.           the  bulletins for these special  monthly Bulletins. You could do
  245.           one each month  for the previous month. The bulletin for the Last
  246.           Import could just  be written  to the current  directory and  not
  247.           used.  For a full month  the Bulletins would  have something like
  248.           01-01-95 to  01-31-95 for the  time period as  this would  be the
  249.           dates in a log for January 1995.
  250.  
  251.                Of  course the  above would  work even  if you  did  not run
  252.           CleanUpP.
  253.  
  254.                It should be noted that when you start using StatusP for the
  255.           first  time that if your Postlink log(s) are not just the current
  256.           month's log(s) that the log does not roll over until the month in
  257.           the log equals your  system's current month (change from  earlier
  258.           versions). The first archive will contain everything to date. The
  259.           new  log will  start at  the first  current month's  date StatusP
  260.           finds  in the current month's log.  Bulletins generated will show
  261.           information only for  the current  month and from  this point  on
  262.           each roll  over archive  will contain  only the previous  month's
  263.           log.
  264.  
  265.  
  266.                                         Errors
  267.  
  268.                Errors are written to the same directory as STATUSP.EXE in a
  269.           file called  STATUSP.ERR. If  the file already  exists additional
  270.           errors  are appended to  the end of  the file. It  may be deleted
  271.           after  you have made  note of any  errors. It's existence  it not
  272.           required by the program.
  273.  
  274.                During  the  start  up  procedures  that  program   displays
  275.           "Searching!" while it is looking for the directory STATUSP.EXE is
  276.           located  in.  Also "Configuring!"  while  it  is reading  in  and
  277.           verifying all information in the configuration file. These are to
  278.           show you what  the program is doing  should lockups occur.  I had
  279.           problems in  these areas and took  some time to isolate  them. At
  280.           least now these problem areas can be isolated. Normally these two
  281.           displays should be very quick  and unreadable depending on system
  282.           speed and StatusP' configuration.
  283.  
  284.                The  program confirms  each item  in the  configuration file
  285.           before  it does  anything  else. Program  aborts  if each  option
  286.           cannot be confirmed.
  287.  
  288.                If StatusP has trouble finding the log(s) it first tries to 
  289.           create a  "no data bulletin" and  do an normal error  exit. If it
  290.           cannot  create  these  bulletins  it makes  an  error  exit  that
  291.           displays  the help screen. These  two exits would  normally be an
  292.  
  293.  
  294.  
  295.  
  296.  
  297.           error  in the  configuration file: wrong  path, wrong  file name,
  298.           configuration file name not used, etc.
  299.  
  300.                If the program has any problems  with your log(s) such as no
  301.           exported conferences found, a  bulletin is generated showing that
  302.           information,  but   no  error  information  is   written  to  the
  303.           STATUSP.ERR.  If  no  imported/exported  messages  are found  the
  304.           program aborts writing out  a no message bulletin for  Export and
  305.           Import along with writing out to STATUSP.ERR.
  306.  
  307.  
  308.                                     Using Postlink
  309.  
  310.                If  you are making two  or more DIFFERENT  network mail runs
  311.           the  only  thing you  must  do  is  make  two or  more  different
  312.           POSTLINK.CFG  files, one with  the name of the  LOG file for each
  313.           network so that ALL logs are not  put into one file. I would have
  314.           no way of knowing  what messages came from what  network in order
  315.           to separate them. You would then just have a TEMP1.CFG, TEMP2.CFG
  316.           and when  you call postlink you just copy TEMP1.CFG POSTLINK.CFG,
  317.           then on next run you might copy TEMP2.CFG POSTLINK.CFG, etc.
  318.  
  319.  
  320.                A simple batch file might look like one of these:
  321.  
  322.                     SET STATUSP=C:\UTILITY
  323.                     CD \POSTLINK
  324.                     COPY TEMP1.CFG POSTLINK.CFG
  325.                     POSTLINK CALLER.CFG
  326.                     STATUSP STATUSP.CFG
  327.                     SET STATUSP=
  328.  
  329.  
  330.                     SET STATUSP=C:\UTILITY
  331.                     CD \POSTLINK
  332.                     Copy TEMP2.CFG POSTLINK.CFG
  333.                     POSTLINK CALLER2.CFG
  334.                     C:\UTILITY\STATUSP STATUSP2.CFG
  335.                     SET STATUSP=
  336.  
  337.                Perhaps you want to  make a bulletin with the  PCBoard color
  338.           codes  and one using straight  ASCII codes and  yet another using
  339.           ANSI  codes, Bright  or Normal  Text Tone.  The .CFG  files would
  340.           contain the bulletin names and the form setting (#9):
  341.  
  342.                STATUSP STATUSP.CFG
  343.                (.CFG with PCB, uses PCBoard color codes and IBM extended
  344.                 graphic characters and bright text tone)
  345.  
  346.                STATUSP STATUSP2.CFG
  347.                (.CFG with ASCII, ASCII and no IBM extended graphic
  348.                 characters and normal text tone [must be populated])
  349.  
  350.                STATUSP STATUSP3.CFG
  351.  
  352.  
  353.  
  354.  
  355.  
  356.                (.CFG with ANSI, ANSI colors and no IBM extended graphic
  357.                 characters and normal text tone)
  358.  
  359.                You just call STATUSP as many  times as needed, with as many
  360.           configuration files  as needed  to generate whatever  formats you
  361.           want. On my 486-33 it  takes less than twenty seconds to  run the
  362.           program on a 6,500 line test log (from three BBS systems).
  363.  
  364.  
  365.                         PKZIP.EXE used by the StatusP Program
  366.  
  367.                "PKZIP.EXE" must be somewhere in your path or in the current
  368.           directory. When  the month  changes in the  export/import.log the
  369.           program  archives the  current log  into a  file using  'SP'+ the
  370.           current date  (SP010193.ZIP, etc.). It also  includes the current
  371.           logs (1 or  2) and all  three bulletins. It  creates this in  the
  372.           directory  that  contains  the  log  file(s).  The  program  then
  373.           rewrites  the log using only  the current new  month's data. This
  374.           way there is only one month's log data in your Postlink log(s).
  375.  
  376.                The  bulletins  are  added  to   the  archive  so  the  last
  377.           information posted on the BBS before rollover is available should
  378.           this information be required by the you.
  379.  
  380.                If you do not want the previous month's log(s) simply delete
  381.           the archive from your hard drive.  In your calling batch file you
  382.           can  add "IF EXIST SP*.ZIP DEL SP*.ZIP" and this will auto-delete
  383.           the archive.
  384.  
  385.                There must  be at least one  meg of free disk  space for the
  386.           archive to be executed. I have no idea the possible  sizes and if
  387.           anyone has problems with the archive with  one meg as the minimum
  388.           please let me know and I will increase the size of the free space
  389.           required.
  390.  
  391.  
  392.  
  393.  
  394.  
  395.                                  The StatusP Program
  396.  
  397.                If you don't like the program please write to me and explain
  398.           why. Send me any suggestions you  might have. If they enhance the
  399.           overall program I will try to incorporate part, some, all, in the
  400.           next release.
  401.  
  402.                 This program package represents  many hours of programming,
  403.           testing,  updating and more testing as well as LD telephone calls
  404.           to get it tested  and to distribute the beta and  release copies.
  405.           Please support my efforts and register your copy.
  406.  
  407.  
  408.                                  StatusP Registration
  409.  
  410.                Please  supply name of  BBS to  be added  to program,  up to
  411.           sixty characters. Anything longer than that will be truncated, no
  412.           exceptions. This is to be on one line of code and must be legible
  413.           since the  serial number  is based on  exact syntax. I  cannot be
  414.           responsible for unreadable data. Please print. Case sensitive!
  415.  
  416.                For  those  who do  not understand  "case sensitive"  I will
  417.           explain since  some people do not  seem to know the  term. If you
  418.           send me  your BBS name in  all capital letters that  is what your
  419.           serial number matches. If you send me your BBS name  in all lower
  420.           case letters your this is what your serial number matches. If you
  421.           send me your BBS name  in capital and lower case letters  that is
  422.           what your serial number matches. Writing small capital letters is
  423.           not the same as lower case. I have gotten registrations where the
  424.           first letter of  words in large capital  letters and the  rest of
  425.           the  letters  in   that  word  in   small  capital  letters.   My
  426.           interpretation is that this  is all uppercase/capital letters. By
  427.           match  means that your  configuration file must  contain the same
  428.           format your serial number is based on: (1) all uppercase, (2) all
  429.           lower case, (3) mixed case.
  430.  
  431.           Example:  "Jim's Graphic  BBS". In  StatusP it  comes out  as the
  432.           following in all bulletins generated:
  433.  
  434.                ==================(Jim's Graphic BBS)==================
  435.  
  436.  
  437.  
  438.  
  439.  
  440.                               StatusP Registration Form
  441.  
  442.  
  443.            [-------------------------------------------------------------]
  444.  
  445.                                  (put BBS name above)
  446.  
  447.                Send BBS information and one of the following in $ U.S.
  448.  
  449.                (1) Registration via mail............................$12
  450.                    (outside U.S./Canada please add $2)
  451.  
  452.                (2) Registration and latest version via mail......... $14
  453.                    (outside U.S./Canada please add $4) Include diskette
  454.                    size.
  455.  
  456.                (3) Registration and latest version via mail and copy
  457.                    of all James Huckabey Doors and PC software...... $17
  458.                    (outside U.S./Canada please add $5) Include diskette
  459.                    size.
  460.  
  461.                         Option: 1: [ ]     2: [ ]     3: [ ] 
  462.  
  463.                Diskette Size: 360: [ ]   1.2: [ ]   720: [ ]  1.44: [ ]
  464.  
  465.                Your current version number: [     ]
  466.  
  467.  
  468.           FROM: 
  469.                   Name: 
  470.                        ---------------------------------------------------
  471.                Address:  
  472.                        ---------------------------------------------------
  473.                   City: 
  474.                        ---------------------------------------------------
  475.            State & Zip: 
  476.                        ---------------------------------------------------
  477.                NODE ID:                      SITE NO:
  478.                        ----------------------        ---------------------
  479.           Phone(voice):                       (data)
  480.                        ----------------------        ---------------------
  481.  
  482.  
  483.                Your registration  number and any  diskettes, if  requesting
  484.           current version or other software, are sent by return mail.
  485.  
  486.                James Huckabey
  487.                3621-A Fraser Street
  488.                Bellingham, Washington 98226-2473 U.S.A.
  489.                (360) 671-2868 (voice, Pacific)
  490.                I do have a US Robotics HST 14.4 DS v32 v42 v42bis modem!